PtInIconID

PtInIconID
Header:	Icons.h		Carbon status:	Supported

Determines whether a specified point is within an icon.

Boolean PtInIconID (
    Point testPt, 
    const Rect *iconRect, 
    IconAlignmentType align, 
    SInt16 iconID
);

testPt: The point to be tested, specified in local coordinates of the current graphics port. A point is considered to be within an icon if the point is within the icon’s mask.
iconRect: A pointer to the rectangle in which the icon appears, specified in local coordinates of the current graphics port. The function determines, from the size of the rectangle specified in this parameter, which icon mask from the given icon family to test the point against. The rectangle which you specify here should be the same rectangle that you last used to draw the icon. The function then uses the location of this rectangle (and the alignment of the icon in the rectangle) to determine whether the specified point is within the icon.
align: Specifies how the icon against which to hit-test is aligned within the rectangle specified by the iconRect parameter. The alignment which you specify here should be the same alignment that you last used to draw the icon. See “Alignment Type Values” for a description of the values you can use in this parameter.
iconID: A resource ID for an icon family. In general, you should specify your icon resources as purgeable.

function result: TRUE if the point is in the icon and FALSE if it is not.

SPECIAL CONSIDERATIONS

This function may move or purge memory blocks in the application heap. For that reason, your application should not call it at interrupt time.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when InterfaceLib 7.1 or later is installed. Exported by CarbonLib 1.0 and later and by InterfaceLib 7.1 and later.